/**
 *   Copyright 2014 Royce Remulla
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 */
package cjcast.common;

import java.io.File;
import java.io.IOException;

/**
 * Solve a code jam problem.
 * 
 * <pre>
 * $Author: royce.com@gmail.com $ 
 * $Date: 2015-02-04 09:03:14 +0000 (Wed, 04 Feb 2015) $
 * </pre>
 * 
 * 
 * @param <T> output type.
 * @author r39
 */
public interface Solution<T> {


    /**
     * Apply solution and generate output for submission.
     * 
     * @param pOutputPath output path of solution files.
     */
    void execute(final String pOutputPath);


    /**
     * Returns an instance of InputReader.
     * 
     * @param inputFile input file to parse.
     * @throws IOException if error occurs while parsing the file.
     */
    CjInputReader<T> getNewInput(final File inputFile) throws IOException;


    /**
     * Implement solution here.
     * 
     * @param caseBean one case to solve.
     * @return expected output.
     */
    String solve(T caseBean);

}
